Skip to content

Add documentation#53

Merged
romainljsimon merged 1 commit into
mainfrom
documentation
Dec 18, 2025
Merged

Add documentation#53
romainljsimon merged 1 commit into
mainfrom
documentation

Conversation

@romainljsimon

Copy link
Copy Markdown
Member

This is the first commit to start the documentation process. The documentation will not build and deploy because ParticlesMC is not on the official registry...yet.
However one can build the documentation locally by running:

julia -project=docs/ docs/make.jl 

after having developed ParticlesMC:

] dev https://github.com/TheDisorderedOrganization/ParticlesMC.git

Closes #12

@codecov

codecov Bot commented Dec 18, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/utils.jl 0.00% 2 Missing ⚠️
Files with missing lines Coverage Δ
src/ParticlesMC.jl 10.11% <ø> (ø)
src/atoms.jl 77.19% <ø> (ø)
src/molecules.jl 71.18% <ø> (ø)
src/moves.jl 54.95% <ø> (ø)
src/utils.jl 86.20% <0.00%> (-6.39%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@romainljsimon romainljsimon merged commit 93ca617 into main Dec 18, 2025
3 checks passed
@romainljsimon romainljsimon deleted the documentation branch December 18, 2025 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation

1 participant